<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PxPlaneGeometry Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="PhysXLogoBlack.png"/></td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classPxPlaneGeometry.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classPxPlaneGeometry-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">PxPlaneGeometry Class Reference<div class="ingroups"><a class="el" href="group__geomutils.html">Geomutils</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Class describing a plane geometry.  
 <a href="classPxPlaneGeometry.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="PxPlaneGeometry_8h_source.html">PxPlaneGeometry.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for PxPlaneGeometry:</div>
<div class="dyncontent">
<div class="center"><img src="classPxPlaneGeometry__inherit__graph.png" border="0" usemap="#PxPlaneGeometry_inherit__map" alt="Inheritance graph"/></div>
<map name="PxPlaneGeometry_inherit__map" id="PxPlaneGeometry_inherit__map">
<area shape="rect" id="node2" href="classPxGeometry.html" title="A geometry object. " alt="" coords="22,5,117,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for PxPlaneGeometry:</div>
<div class="dyncontent">
<div class="center"><img src="classPxPlaneGeometry__coll__graph.png" border="0" usemap="#PxPlaneGeometry_coll__map" alt="Collaboration graph"/></div>
<map name="PxPlaneGeometry_coll__map" id="PxPlaneGeometry_coll__map">
<area shape="rect" id="node2" href="classPxGeometry.html" title="A geometry object. " alt="" coords="22,5,117,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad71ebf9ac3a2f3831fb65dfe91adf505"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPlaneGeometry.html#ad71ebf9ac3a2f3831fb65dfe91adf505">PxPlaneGeometry</a> ()</td></tr>
<tr class="separator:ad71ebf9ac3a2f3831fb65dfe91adf505"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga880239cc33c00344cee0a4e32c573561"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__geomutils.html#ga880239cc33c00344cee0a4e32c573561">isValid</a> () const</td></tr>
<tr class="memdesc:ga880239cc33c00344cee0a4e32c573561"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the geometry is valid.  <a href="group__geomutils.html#ga880239cc33c00344cee0a4e32c573561">More...</a><br /></td></tr>
<tr class="separator:ga880239cc33c00344cee0a4e32c573561"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classPxGeometry"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classPxGeometry')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classPxGeometry.html">PxGeometry</a></td></tr>
<tr class="memitem:a681b898f104db56c0012fe8f7f172d15 inherit pub_methods_classPxGeometry"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#ga6e444d58dbf1459261fadc9b79594f63">PX_CUDA_CALLABLE</a> <a class="el" href="group__foundation.html#ga6a774eed3cad34b0f636332a3d28c6bb">PX_FORCE_INLINE</a> <a class="el" href="structPxGeometryType.html#aefc79f72c4c479192ac19d41a6f30ed5">PxGeometryType::Enum</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxGeometry.html#a681b898f104db56c0012fe8f7f172d15">getType</a> () const</td></tr>
<tr class="memdesc:a681b898f104db56c0012fe8f7f172d15 inherit pub_methods_classPxGeometry"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the type of the geometry.  <a href="classPxGeometry.html#a681b898f104db56c0012fe8f7f172d15">More...</a><br /></td></tr>
<tr class="separator:a681b898f104db56c0012fe8f7f172d15 inherit pub_methods_classPxGeometry"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classPxGeometry"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classPxGeometry')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classPxGeometry.html">PxGeometry</a></td></tr>
<tr class="memitem:a2507c9f4d63fe816968fe9a2744ac549 inherit pro_methods_classPxGeometry"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#ga6e444d58dbf1459261fadc9b79594f63">PX_CUDA_CALLABLE</a> <a class="el" href="group__foundation.html#ga6a774eed3cad34b0f636332a3d28c6bb">PX_FORCE_INLINE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxGeometry.html#a2507c9f4d63fe816968fe9a2744ac549">PxGeometry</a> (<a class="el" href="structPxGeometryType.html#aefc79f72c4c479192ac19d41a6f30ed5">PxGeometryType::Enum</a> type)</td></tr>
<tr class="separator:a2507c9f4d63fe816968fe9a2744ac549 inherit pro_methods_classPxGeometry"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_classPxGeometry"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classPxGeometry')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classPxGeometry.html">PxGeometry</a></td></tr>
<tr class="memitem:af24eeb8078fbd12e17206029b52a45b6 inherit pro_attribs_classPxGeometry"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structPxGeometryType.html#aefc79f72c4c479192ac19d41a6f30ed5">PxGeometryType::Enum</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxGeometry.html#af24eeb8078fbd12e17206029b52a45b6">mType</a></td></tr>
<tr class="separator:af24eeb8078fbd12e17206029b52a45b6 inherit pro_attribs_classPxGeometry"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class describing a plane geometry. </p>
<p>The plane geometry specifies the half-space volume x&lt;=0. As with other geometry types, when used in a <a class="el" href="classPxShape.html" title="Abstract class for collision shapes. ">PxShape</a> the collision volume is obtained by transforming the halfspace by the shape local pose and the actor global pose.</p>
<p>To generate a <a class="el" href="classPxPlane.html" title="Representation of a plane. ">PxPlane</a> from a <a class="el" href="classPxTransform.html" title="class representing a rigid euclidean transform as a quaternion and a vector ">PxTransform</a>, transform <a class="el" href="classPxPlane.html" title="Representation of a plane. ">PxPlane(1,0,0,0)</a>.</p>
<p>To generate a <a class="el" href="classPxTransform.html" title="class representing a rigid euclidean transform as a quaternion and a vector ">PxTransform</a> from a <a class="el" href="classPxPlane.html" title="Representation of a plane. ">PxPlane</a>, use PxTransformFromPlaneEquation.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxShape.html#ac6112e8c0ee9803eb3436bbaf673d98a" title="Adjust the geometry of the shape. ">PxShape.setGeometry()</a> <a class="el" href="classPxShape.html#afe05ad6f093d762abaf03e3e0c1de704" title="Fetch the geometry of the shape. ">PxShape.getPlaneGeometry()</a> <a class="el" href="group__common.html#gad7702c73625ee858ad6458b97856d475" title="creates a transform from a plane equation, suitable for an actor transform for a PxPlaneGeometry ...">PxTransformFromPlaneEquation</a> </dd></dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ad71ebf9ac3a2f3831fb65dfe91adf505"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad71ebf9ac3a2f3831fb65dfe91adf505">&#9670;&nbsp;</a></span>PxPlaneGeometry()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> PxPlaneGeometry::PxPlaneGeometry </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxPlaneGeometry_8h_source.html">PxPlaneGeometry.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="classPxPlaneGeometry.html">PxPlaneGeometry</a></li>
    <li class="footer">Copyright &copy; 2008-2021 NVIDIA Corporation, 2788 San Tomas Expressway, Santa Clara, CA 95051 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a></li>
  </ul>
</div>
</body>
</html>
